FHIR Server FHIR Server Version n/a

Resource CapabilityStatement/FHIR Server from package hl7.fhir.us.carin-bb#current (78 ms)

Package

hl7.fhir.us.carin-bb

Type

CapabilityStatement

FHIR Version

Source

http://hl7.org/fhir/us/carin-bb/https://build.fhir.org/ig/HL7/carin-bb/CapabilityStatement-c4bb.html

Url

http://hl7.org/fhir/us/carin-bb/CapabilityStatement/c4bb

Version

2.1.0

Status

active

Date

2022-09-11

Name

CarinBbCapabilityStatement

Title

C4BB CapabilityStatement

Experimental

False

Realm

Authority

hl7

Description

This Section describes the expected capabilities of the C4BB Server actor which is responsible for providing responses to the queries submitted by the C4BB Requestors. The EOB Resource is the focal Consumer-Directed Payer Data Exchange (CDPDE) Resource. Several Reference Resources are defined directly/indirectly from the EOB: Coverage, Patient, Organization (Payer ID), Practioner, and Organization (Facility). The Coverage Reference Resource SHALL be returned with data that was effective as of the date of service of the claim; for example, the data will reflect the employer name in effect at that time. However, for other reference resources, payers MAY decide to provide either the data that was in effect as of the date of service or the current data. All reference resources within the EOB will have meta.lastUpdated flagged as must support. Payers SHALL provide the last time the data was updated or the date of creation in the payers system of record, whichever comes last. Apps will use the meta.lastUpdated values to determine if the reference resources are as of the current date or date of service.

Kind

requirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide

hl7.fhir.us.carin-bb

CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®)

http://hl7.org/fhir/us/carin-bb/SearchParameter/explanationofbenefit-billable-period-start

ExplanationOfBenefit_BillablePeriodStart

http://hl7.org/fhir/us/carin-bb/SearchParameter/explanationofbenefit-identifier

ExplanationOfBenefit_Identifier

http://hl7.org/fhir/us/carin-bb/SearchParameter/explanationofbenefit-patient

ExplanationOfBenefit_Patient

http://hl7.org/fhir/us/carin-bb/SearchParameter/explanationofbenefit-service-date

ExplanationOfBenefit_ServiceDate

http://hl7.org/fhir/us/carin-bb/SearchParameter/explanationofbenefit-service-start-date

ExplanationOfBenefit_ServiceStartDate

http://hl7.org/fhir/us/carin-bb/SearchParameter/explanationofbenefit-type

ExplanationOfBenefit_Type

http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage

C4BB Coverage

http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Inpatient-Institutional

C4BB ExplanationOfBenefit Inpatient Institutional

http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Oral

C4BB ExplanationOfBenefit Oral

http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Outpatient-Institutional

C4BB ExplanationOfBenefit Outpatient Institutional

http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Pharmacy

C4BB ExplanationOfBenefit Pharmacy

http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Professional-NonClinician

C4BB ExplanationOfBenefit Professional NonClinician

http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit

C4BB Explanation Of Benefit

http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization

C4BB Organization

http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient

C4BB Patient

http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Practitioner

C4BB Practitioner

http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson

C4BB RelatedPerson

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement c4bb

C4BB CapabilityStatement

Implementation Guide Version: 2.1.0
FHIR Version: 4.0.1
Supported Formats: xml, json
Supported Patch Formats:
Published on: 2022-09-11
Published by: HL7 International / Financial Management

Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

http://hl7.org/fhir/us/carin-bb/ImplementationGuide/hl7.fhir.us.carin-bb

FHIR RESTful Capabilities

Mode: `server`

The C4BB Server SHALL:

Support all profiles defined in this Implementation Guide..
Implement the RESTful behavior according to the FHIR specification.
Return the following response classes:
- (Status 400): invalid parameter
- (Status 401/4xx): unauthorized request
- (Status 403): insufficient scope
- (Status 404): unknown resource
- (Status 410): deleted resource.
Support json source formats for all CARIN-BB interactions.
Identify the CARIN-BB profiles supported as part of the FHIR meta.profile attribute for each instance.
Support the searchParameters on each profile individually and in combination.

The C4BB Server SHOULD:

Support xml source formats for all C4BB interactions.

Security

See the General Security Considerations section for requirements and recommendations.

A server SHALL reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found" .

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

The relevant profiles (if any)
The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
The required, recommended, and some optional search parameters (if any).
The linked resources enabled for _include
The other resources enabled for _revinclude
The operations on the resource (if any)

Resource Type	Profile	R	V-R	S	Searches	`_include`
Coverage	Supported Profiles C4BB Coverage	y	y	y	_id, _lastUpdated	`Coverage:payor`
ExplanationOfBenefit	Supported Profiles C4BB Explanation Of Benefit C4BB ExplanationOfBenefit Inpatient Institutional C4BB ExplanationOfBenefit Outpatient Institutional C4BB ExplanationOfBenefit Oral C4BB ExplanationOfBenefit Pharmacy C4BB ExplanationOfBenefit Professional NonClinician	y	y	y	_id, patient, _lastUpdated, type, identifier, service-date, service-start-date, billable-period-start	`ExplanationOfBenefit:patient`, `ExplanationOfBenefit:provider`, `ExplanationOfBenefit:care-team`, `ExplanationOfBenefit:coverage`, `ExplanationOfBenefit:insurer`, `ExplanationOfBenefit:payee`, `ExplanationOfBenefit:*`
Organization	Supported Profiles C4BB Organization	y	y	y	_id, _lastUpdated
Patient	Supported Profiles C4BB Patient	y	y	y	_id, _lastUpdated
Practitioner	Supported Profiles C4BB Practitioner	y	y	y	_id, _lastUpdated
RelatedPerson	Supported Profiles C4BB RelatedPerson	y	y	y	_id, _lastUpdated

Resource Conformance: SHALL Coverage

Core FHIR Resource
Coverage

Reference Policy
resolves

Interaction summary

SHALL support search-type, read.
SHOULD support vread.

Supported Profiles

C4BB Coverage

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	http://hl7.org/fhir/R4/search.html#id
SHOULD	_lastUpdated	`date`	http://hl7.org/fhir/R4/search.html#lastUpdated

Resource Conformance: SHALL ExplanationOfBenefit

Core FHIR Resource
ExplanationOfBenefit

Reference Policy
resolves

Interaction summary

SHALL support read
search-type
_include:* SHALL be supported.

Note: _include=ExplanationOfBenefit:* means, at minimum, the resources that are included as reference type search parameters for the ExplanationOfBenefit resource on the server. Servers claiming compliance to this guide will, at minimum, support the include of patient, provider, care-team, coverage, insurer, and payee, and will support returning all of them in support ExplanationOfBenefit:* (Where not supported only as contained resources). Not all of these are defined as required search parameters, but are defined as part of the _include requirement. For example, the insurer search parameter is not required because in the context of the use case, it is anticipated there will ever be one insurer. It however must be returned in the _include=ExplanationOfBenefit:* results. The means in which this is done (including defining all of the _include as search parameters) is not defined.
SHOULD support vread.

Supported Profiles

C4BB Explanation Of Benefit
C4BB ExplanationOfBenefit Inpatient Institutional
C4BB ExplanationOfBenefit Outpatient Institutional
C4BB ExplanationOfBenefit Oral
C4BB ExplanationOfBenefit Pharmacy
C4BB ExplanationOfBenefit Professional NonClinician

Documentation

When an EOB references another resource (e.g., Patient or Practitioner), the reference may be versioned or versionless. Payers SHALL use versioned references whenever they maintain point-in-time data (data that was effective as of the date of service or date of admission on the claim), but MAY use versionless references when they do not maintain versioned data. Clients MAY request referenced resources as part of an EOB search (by supplying the _include parameter) or directly using read or vread. Payers SHALL support both approaches, and SHALL return the same content for referenced resources in either case. “:iterate" should be used if you request to include Coverage:payor in the EOB response bundle, e.g. GET [base]/ExplanationOfBenefit?_id[parameter=value]&_include=ExplanationOfBenefit:coverage&_include:iterate=Coverage:payor.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	http://hl7.org/fhir/R4/search.html#id
SHALL	patient	`reference`
SHALL	_lastUpdated	`date`	http://hl7.org/fhir/R4/search.html#lastUpdated
SHALL	type	`token`
SHALL	identifier	`token`
SHALL	service-date	`date`
SHALL	service-start-date	`date`
SHALL	billable-period-start	`date`

Resource Conformance: SHOULD Organization

Core FHIR Resource
Organization

Reference Policy
resolves

Interaction summary

SHALL support read.
SHOULD support vread.
MAY support search-type.

Supported Profiles

C4BB Organization

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	http://hl7.org/fhir/R4/search.html#id
SHOULD	_lastUpdated	`date`	http://hl7.org/fhir/R4/search.html#lastUpdated

Resource Conformance: SHALL Patient

Core FHIR Resource
Patient

Reference Policy
resolves

Interaction summary

SHALL support read.
SHOULD support vread.
MAY support search-type.

Supported Profiles

C4BB Patient

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	http://hl7.org/fhir/R4/search.html#id
SHOULD	_lastUpdated	`date`	http://hl7.org/fhir/R4/search.html#lastUpdated

Resource Conformance: SHOULD Practitioner

Core FHIR Resource
Practitioner

Reference Policy
resolves

Interaction summary

SHALL support read.
SHOULD support vread.
MAY support search-type.

Supported Profiles

C4BB Practitioner

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	http://hl7.org/fhir/R4/search.html#id
SHOULD	_lastUpdated	`date`	http://hl7.org/fhir/R4/search.html#lastUpdated

Resource Conformance: SHOULD RelatedPerson

Core FHIR Resource
RelatedPerson

Reference Policy
resolves

Interaction summary

SHALL support read.
SHOULD support vread.
MAY support search-type.

Supported Profiles

C4BB RelatedPerson

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	http://hl7.org/fhir/R4/search.html#id
SHOULD	_lastUpdated	`date`	http://hl7.org/fhir/R4/search.html#lastUpdated

Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "c4bb",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement c4bb</b></p><a name=\"c4bb\"> </a><a name=\"hcc4bb\"> </a><a name=\"c4bb-en-US\"> </a><h2 id=\"title\">C4BB CapabilityStatement</h2><ul><li>Implementation Guide Version: 2.1.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2022-09-11 </li><li>Published by: HL7 International / Financial Management </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li><a href=\"index.html\">http://hl7.org/fhir/us/carin-bb/ImplementationGuide/hl7.fhir.us.carin-bb</a></li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>The C4BB  Server <strong>SHALL</strong>:</p>\n<ol>\n<li>Support all profiles defined in this Implementation Guide..</li>\n<li>Implement the RESTful behavior according to the FHIR specification.</li>\n<li>Return the following response classes:\n<ul>\n<li>(Status 400): invalid parameter</li>\n<li>(Status 401/4xx): unauthorized request</li>\n<li>(Status 403): insufficient scope</li>\n<li>(Status 404): unknown resource</li>\n<li>(Status 410): deleted resource.</li>\n</ul>\n</li>\n<li>Support json source formats for all CARIN-BB interactions.</li>\n<li>Identify the CARIN-BB  profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</li>\n<li>Support the searchParameters on each profile  individually and in combination.</li>\n</ol>\n<p>The C4BB  Server <strong>SHOULD</strong>:</p>\n<ol>\n<li>Support xml source formats for all C4BB interactions.</li>\n</ol>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><ol>\n<li>See the <a href=\"Security_And_Privacy_Considerations.html\">General Security Considerations</a> section for requirements and recommendations.</li>\n<li>A server <strong>SHALL</strong> reject any unauthorized requests by returning an HTTP 401 &quot;Unauthorized&quot;, HTTP 403 &quot;Forbidden&quot;, or HTTP 404 &quot;Not Found&quot; .</li>\n</ol>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET past versions of resources (vread interaction)\">V-R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Coverage1-1\">Coverage</a></td><td>Supported Profiles<br/>ï¿½ï¿½<a href=\"StructureDefinition-C4BB-Coverage.html\">C4BB Coverage</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated</td><td><code>Coverage:payor</code></td><td/><td/></tr><tr><td><a href=\"#ExplanationOfBenefit1-2\">ExplanationOfBenefit</a></td><td>Supported Profiles<br/>ï¿½ï¿½<a href=\"StructureDefinition-C4BB-ExplanationOfBenefit.html\">C4BB Explanation Of Benefit</a><br/>ï¿½ï¿½<a href=\"StructureDefinition-C4BB-ExplanationOfBenefit-Inpatient-Institutional.html\">C4BB ExplanationOfBenefit Inpatient Institutional</a><br/>ï¿½ï¿½<a href=\"StructureDefinition-C4BB-ExplanationOfBenefit-Outpatient-Institutional.html\">C4BB ExplanationOfBenefit Outpatient Institutional</a><br/>ï¿½ï¿½<a href=\"StructureDefinition-C4BB-ExplanationOfBenefit-Oral.html\">C4BB ExplanationOfBenefit Oral</a><br/>ï¿½ï¿½<a href=\"StructureDefinition-C4BB-ExplanationOfBenefit-Pharmacy.html\">C4BB ExplanationOfBenefit Pharmacy</a><br/>ï¿½ï¿½<a href=\"StructureDefinition-C4BB-ExplanationOfBenefit-Professional-NonClinician.html\">C4BB ExplanationOfBenefit Professional NonClinician</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, patient, _lastUpdated, type, identifier, service-date, service-start-date, billable-period-start</td><td><code>ExplanationOfBenefit:patient</code>, <code>ExplanationOfBenefit:provider</code>, <code>ExplanationOfBenefit:care-team</code>, <code>ExplanationOfBenefit:coverage</code>, <code>ExplanationOfBenefit:insurer</code>, <code>ExplanationOfBenefit:payee</code>, <code>ExplanationOfBenefit:*</code></td><td/><td/></tr><tr><td><a href=\"#Organization1-3\">Organization</a></td><td>Supported Profiles<br/>ï¿½ï¿½<a href=\"StructureDefinition-C4BB-Organization.html\">C4BB Organization</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated</td><td/><td/><td/></tr><tr><td><a href=\"#Patient1-4\">Patient</a></td><td>Supported Profiles<br/>ï¿½ï¿½<a href=\"StructureDefinition-C4BB-Patient.html\">C4BB Patient</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated</td><td/><td/><td/></tr><tr><td><a href=\"#Practitioner1-5\">Practitioner</a></td><td>Supported Profiles<br/>ï¿½ï¿½<a href=\"StructureDefinition-C4BB-Practitioner.html\">C4BB Practitioner</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated</td><td/><td/><td/></tr><tr><td><a href=\"#RelatedPerson1-6\">RelatedPerson</a></td><td>Supported Profiles<br/>ï¿½ï¿½<a href=\"StructureDefinition-C4BB-RelatedPerson.html\">C4BB RelatedPerson</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Coverage1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Coverage</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/coverage.html\">Coverage</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-C4BB-Coverage.html\">C4BB Coverage</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>http://hl7.org/fhir/R4/search.html#id</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>http://hl7.org/fhir/R4/search.html#lastUpdated</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">ï¿½</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"ExplanationOfBenefit1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>ExplanationOfBenefit</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/explanationofbenefit.html\">ExplanationOfBenefit</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code><br/><code>search-type</code><div><p>_include:* SHALL be supported.</p>\n<p>Note: <code>_include=ExplanationOfBenefit:*</code> means, at minimum, the resources that are included as reference type search parameters for the ExplanationOfBenefit resource on the server. Servers claiming compliance to this guide will, at minimum, support the include of <code>patient</code>, <code>provider</code>, <code>care-team</code>, <code>coverage</code>, <code>insurer</code>, and <code>payee</code>, and will support returning all of them in support <code>ExplanationOfBenefit:*</code> (Where not supported only as contained resources). Not all of these are defined as required search parameters, but are defined as part of the _include requirement. For example, the insurer search parameter is not required because in the context of the use case, it is anticipated there will ever be one insurer. It however must be returned in the <code>_include=ExplanationOfBenefit:*</code> results. The means in which this is done (including defining all of the _include as search parameters) is not defined.</p>\n</div></li><li><strong>SHOULD</strong> support <code>vread</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-C4BB-ExplanationOfBenefit.html\">C4BB Explanation Of Benefit</a><br/><a href=\"StructureDefinition-C4BB-ExplanationOfBenefit-Inpatient-Institutional.html\">C4BB ExplanationOfBenefit Inpatient Institutional</a><br/><a href=\"StructureDefinition-C4BB-ExplanationOfBenefit-Outpatient-Institutional.html\">C4BB ExplanationOfBenefit Outpatient Institutional</a><br/><a href=\"StructureDefinition-C4BB-ExplanationOfBenefit-Oral.html\">C4BB ExplanationOfBenefit Oral</a><br/><a href=\"StructureDefinition-C4BB-ExplanationOfBenefit-Pharmacy.html\">C4BB ExplanationOfBenefit Pharmacy</a><br/><a href=\"StructureDefinition-C4BB-ExplanationOfBenefit-Professional-NonClinician.html\">C4BB ExplanationOfBenefit Professional NonClinician</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>When an EOB references another resource (e.g., Patient or Practitioner), the reference may be versioned or versionless. Payers SHALL use versioned references whenever they maintain point-in-time data (data that was effective as of the date of service or date of admission on the claim), but MAY use versionless references when they do not maintain versioned data. Clients MAY request referenced resources as part of an EOB search (by supplying the _include parameter) or directly using read or vread. Payers SHALL support both approaches, and SHALL return the same content for referenced resources in either case. â€œ:iterate&quot; should be used if you request to include Coverage:payor in the EOB response bundle, e.g. GET [base]/ExplanationOfBenefit?_id[parameter=value]&amp;_include=ExplanationOfBenefit:coverage&amp;_include:iterate=Coverage:payor.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>http://hl7.org/fhir/R4/search.html#id</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-explanationofbenefit-patient.html\">patient</a></td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>http://hl7.org/fhir/R4/search.html#lastUpdated</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-explanationofbenefit-type.html\">type</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-explanationofbenefit-identifier.html\">identifier</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-explanationofbenefit-service-date.html\">service-date</a></td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-explanationofbenefit-service-start-date.html\">service-start-date</a></td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-explanationofbenefit-billable-period-start.html\">billable-period-start</a></td><td><code>date</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">ï¿½</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Organization1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Organization</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/organization.html\">Organization</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>.</li><li><strong>MAY</strong> support <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-C4BB-Organization.html\">C4BB Organization</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>http://hl7.org/fhir/R4/search.html#id</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>http://hl7.org/fhir/R4/search.html#lastUpdated</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">ï¿½</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>.</li><li><strong>MAY</strong> support <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-C4BB-Patient.html\">C4BB Patient</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>http://hl7.org/fhir/R4/search.html#id</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>http://hl7.org/fhir/R4/search.html#lastUpdated</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">ï¿½</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Practitioner1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Practitioner</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/practitioner.html\">Practitioner</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>.</li><li><strong>MAY</strong> support <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-C4BB-Practitioner.html\">C4BB Practitioner</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>http://hl7.org/fhir/R4/search.html#id</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>http://hl7.org/fhir/R4/search.html#lastUpdated</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">ï¿½</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"RelatedPerson1-6\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>RelatedPerson</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/relatedperson.html\">RelatedPerson</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>.</li><li><strong>MAY</strong> support <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-C4BB-RelatedPerson.html\">C4BB RelatedPerson</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>http://hl7.org/fhir/R4/search.html#id</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>http://hl7.org/fhir/R4/search.html#lastUpdated</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">ï¿½</div></div></div></div></div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "fm"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/carin-bb/ImplementationGuide/hl7.fhir.us.carin-bb"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/us/carin-bb/CapabilityStatement/c4bb",
  "version" : "2.1.0",
  "name" : "CarinBbCapabilityStatement",
  "title" : "C4BB CapabilityStatement",
  "status" : "active",
  "experimental" : false,
  "date" : "2022-09-11",
  "publisher" : "HL7 International / Financial Management",
  "contact" : [
    {
      "name" : "HL7 International / Financial Management",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/fm"
        },
        {
          "system" : "email",
          "value" : "fm@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "This Section describes the expected capabilities of the C4BB Server actor which is responsible for providing responses to the queries submitted by the C4BB Requestors. \n\nThe EOB Resource is the focal Consumer-Directed Payer Data Exchange (CDPDE) Resource. Several Reference Resources are defined directly/indirectly from the EOB: Coverage, Patient, Organization (Payer ID), Practioner, and Organization (Facility).\n\nThe Coverage Reference Resource SHALL be returned with data that was effective as of the date of service of the claim; for example, the data will reflect the employer name in effect at that time. However, for other reference resources, payers MAY decide to provide either the data that was in effect as of the date of service or the current data. All reference resources within the EOB will have meta.lastUpdated flagged as must support. Payers SHALL provide the last time the data was updated or the date of creation in the payers system of record, whichever comes last. Apps will use the meta.lastUpdated values to determine if the reference resources are as of the current date or date of service.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "xml",
    "json"
  ],
  "implementationGuide" : [
    "http://hl7.org/fhir/us/carin-bb/ImplementationGuide/hl7.fhir.us.carin-bb"
  ],
  "rest" : [
    {
      "mode" : "server",
      "documentation" : "The C4BB  Server **SHALL**:\n\n1. Support all profiles defined in this Implementation Guide..\n2.  Implement the RESTful behavior according to the FHIR specification.\n3. Return the following response classes:\n   - (Status 400): invalid parameter\n   - (Status 401/4xx): unauthorized request\n   - (Status 403): insufficient scope\n   - (Status 404): unknown resource\n   - (Status 410): deleted resource.\n4. Support json source formats for all CARIN-BB interactions.\n5. Identify the CARIN-BB  profiles supported as part of the FHIR `meta.profile` attribute for each instance.\n6. Support the searchParameters on each profile  individually and in combination.\n\nThe C4BB  Server **SHOULD**:\n\n1. Support xml source formats for all C4BB interactions.\n",
      "security" : {
        "description" : "1. See the [General Security Considerations](Security_And_Privacy_Considerations.html) section for requirements and recommendations.\n2. A server **SHALL** reject any unauthorized requests by returning an HTTP 401 \"Unauthorized\", HTTP 403 \"Forbidden\", or HTTP 404 \"Not Found\" ."
      },
      "resource" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "Coverage",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchInclude" : [
            "Coverage:payor"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token",
              "documentation" : "http://hl7.org/fhir/R4/search.html#id"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date",
              "documentation" : "http://hl7.org/fhir/R4/search.html#lastUpdated"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "ExplanationOfBenefit",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit",
            "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Inpatient-Institutional",
            "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Outpatient-Institutional",
            "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Oral",
            "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Pharmacy",
            "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Professional-NonClinician"
          ],
          "documentation" : "When an EOB references another resource (e.g., Patient or Practitioner), the reference may be versioned or versionless. Payers SHALL use versioned references whenever they maintain point-in-time data (data that was effective as of the date of service or date of admission on the claim), but MAY use versionless references when they do not maintain versioned data. Clients MAY request referenced resources as part of an EOB search (by supplying the _include parameter) or directly using read or vread. Payers SHALL support both approaches, and SHALL return the same content for referenced resources in either case. â€œ:iterate\" should be used if you request to include Coverage:payor in the EOB response bundle, e.g. GET [base]/ExplanationOfBenefit?_id[parameter=value]&_include=ExplanationOfBenefit:coverage&_include:iterate=Coverage:payor.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type",
              "documentation" : "_include:* SHALL be supported.\n\n\nNote: `_include=ExplanationOfBenefit:*` means, at minimum, the resources that are included as reference type search parameters for the ExplanationOfBenefit resource on the server. Servers claiming compliance to this guide will, at minimum, support the include of `patient`, `provider`, `care-team`, `coverage`, `insurer`, and `payee`, and will support returning all of them in support `ExplanationOfBenefit:*` (Where not supported only as contained resources). Not all of these are defined as required search parameters, but are defined as part of the _include requirement. For example, the insurer search parameter is not required because in the context of the use case, it is anticipated there will ever be one insurer. It however must be returned in the `_include=ExplanationOfBenefit:*` results. The means in which this is done (including defining all of the _include as search parameters) is not defined.\n"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchInclude" : [
            "ExplanationOfBenefit:patient",
            "ExplanationOfBenefit:provider",
            "ExplanationOfBenefit:care-team",
            "ExplanationOfBenefit:coverage",
            "ExplanationOfBenefit:insurer",
            "ExplanationOfBenefit:payee",
            "ExplanationOfBenefit:*"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token",
              "documentation" : "http://hl7.org/fhir/R4/search.html#id"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "patient",
              "definition" : "http://hl7.org/fhir/us/carin-bb/SearchParameter/explanationofbenefit-patient",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date",
              "documentation" : "http://hl7.org/fhir/R4/search.html#lastUpdated"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "type",
              "definition" : "http://hl7.org/fhir/us/carin-bb/SearchParameter/explanationofbenefit-type",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "identifier",
              "definition" : "http://hl7.org/fhir/us/carin-bb/SearchParameter/explanationofbenefit-identifier",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "service-date",
              "definition" : "http://hl7.org/fhir/us/carin-bb/SearchParameter/explanationofbenefit-service-date",
              "type" : "date"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "service-start-date",
              "definition" : "http://hl7.org/fhir/us/carin-bb/SearchParameter/explanationofbenefit-service-start-date",
              "type" : "date"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "billable-period-start",
              "definition" : "http://hl7.org/fhir/us/carin-bb/SearchParameter/explanationofbenefit-billable-period-start",
              "type" : "date"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            }
          ],
          "type" : "Organization",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token",
              "documentation" : "http://hl7.org/fhir/R4/search.html#id"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date",
              "documentation" : "http://hl7.org/fhir/R4/search.html#lastUpdated"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "Patient",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token",
              "documentation" : "http://hl7.org/fhir/R4/search.html#id"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date",
              "documentation" : "http://hl7.org/fhir/R4/search.html#lastUpdated"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            }
          ],
          "type" : "Practitioner",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Practitioner"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token",
              "documentation" : "http://hl7.org/fhir/R4/search.html#id"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date",
              "documentation" : "http://hl7.org/fhir/R4/search.html#lastUpdated"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            }
          ],
          "type" : "RelatedPerson",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token",
              "documentation" : "http://hl7.org/fhir/R4/search.html#id"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date",
              "documentation" : "http://hl7.org/fhir/R4/search.html#lastUpdated"
            }
          ]
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.

Resource CapabilityStatement/FHIR Server from package hl7.fhir.us.carin-bb#current (78 ms)

Resources that use this resource

Resources that this resource uses

Narrative

C4BB CapabilityStatement

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALL Coverage

Resource Conformance: SHALL ExplanationOfBenefit

Resource Conformance: SHOULD Organization

Resource Conformance: SHALL Patient

Resource Conformance: SHOULD Practitioner

Resource Conformance: SHOULD RelatedPerson

Source

Mode: `server`